<!DOCTYPE html>
<html lang="en-us">
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    
<meta charset="UTF-8">
<title>Jira action | Elasticsearch Guide [7.7] | Elastic</title>
<link rel="home" href="index.html" title="Elasticsearch Guide [7.7]">
<link rel="up" href="actions.html" title="Actions">
<link rel="prev" href="actions-pagerduty.html" title="PagerDuty action">
<link rel="next" href="transform.html" title="Payload transforms">
<meta name="DC.type" content="Learn/Docs/Elasticsearch/Reference/7.7">
<meta name="DC.subject" content="Elasticsearch">
<meta name="DC.identifier" content="7.7">
<meta name="robots" content="noindex,nofollow">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script src="https://cdn.optimizely.com/js/18132920325.js"></script>
    <link rel="apple-touch-icon" sizes="57x57" href="/apple-icon-57x57.png">
    <link rel="apple-touch-icon" sizes="60x60" href="/apple-icon-60x60.png">
    <link rel="apple-touch-icon" sizes="72x72" href="/apple-icon-72x72.png">
    <link rel="apple-touch-icon" sizes="76x76" href="/apple-icon-76x76.png">
    <link rel="apple-touch-icon" sizes="114x114" href="/apple-icon-114x114.png">
    <link rel="apple-touch-icon" sizes="120x120" href="/apple-icon-120x120.png">
    <link rel="apple-touch-icon" sizes="144x144" href="/apple-icon-144x144.png">
    <link rel="apple-touch-icon" sizes="152x152" href="/apple-icon-152x152.png">
    <link rel="apple-touch-icon" sizes="180x180" href="/apple-icon-180x180.png">
    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
    <link rel="manifest" href="/manifest.json">
    <meta name="apple-mobile-web-app-title" content="Elastic">
    <meta name="application-name" content="Elastic">
    <meta name="msapplication-TileColor" content="#ffffff">
    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
    <meta name="theme-color" content="#ffffff">
    <meta name="naver-site-verification" content="936882c1853b701b3cef3721758d80535413dbfd">
    <meta name="yandex-verification" content="d8a47e95d0972434">
    <meta name="localized" content="true">
    <meta name="st:robots" content="follow,index">
    <meta property="og:image" content="https://www.elastic.co/static/images/elastic-logo-200.png">
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
    <link rel="icon" href="/favicon.ico" type="image/x-icon">
    <link rel="apple-touch-icon-precomposed" sizes="64x64" href="/favicon_64x64_16bit.png">
    <link rel="apple-touch-icon-precomposed" sizes="32x32" href="/favicon_32x32.png">
    <link rel="apple-touch-icon-precomposed" sizes="16x16" href="/favicon_16x16.png">
    <!-- Give IE8 a fighting chance -->
    <!--[if lt IE 9]>
    <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
    <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
    <![endif]-->
    <link rel="stylesheet" type="text/css" href="/guide/static/styles.css">
  </head>

  <!--© 2015-2021 Elasticsearch B.V. Copying, publishing and/or distributing without written permission is strictly prohibited.-->

  <body>
    <!-- Google Tag Manager -->
    <script>dataLayer = [];</script><noscript><iframe src="//www.googletagmanager.com/ns.html?id=GTM-58RLH5" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
    <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= '//www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-58RLH5');</script>
    <!-- End Google Tag Manager -->

    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-12395217-16"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());
      gtag('config', 'UA-12395217-16');
    </script>

    <!--BEGIN QUALTRICS WEBSITE FEEDBACK SNIPPET-->
    <script type="text/javascript">
      (function(){var g=function(e,h,f,g){
      this.get=function(a){for(var a=a+"=",c=document.cookie.split(";"),b=0,e=c.length;b<e;b++){for(var d=c[b];" "==d.charAt(0);)d=d.substring(1,d.length);if(0==d.indexOf(a))return d.substring(a.length,d.length)}return null};
      this.set=function(a,c){var b="",b=new Date;b.setTime(b.getTime()+6048E5);b="; expires="+b.toGMTString();document.cookie=a+"="+c+b+"; path=/; "};
      this.check=function(){var a=this.get(f);if(a)a=a.split(":");else if(100!=e)"v"==h&&(e=Math.random()>=e/100?0:100),a=[h,e,0],this.set(f,a.join(":"));else return!0;var c=a[1];if(100==c)return!0;switch(a[0]){case "v":return!1;case "r":return c=a[2]%Math.floor(100/c),a[2]++,this.set(f,a.join(":")),!c}return!0};
      this.go=function(){if(this.check()){var a=document.createElement("script");a.type="text/javascript";a.src=g;document.body&&document.body.appendChild(a)}};
      this.start=function(){var a=this;window.addEventListener?window.addEventListener("load",function(){a.go()},!1):window.attachEvent&&window.attachEvent("onload",function(){a.go()})}};
      try{(new g(100,"r","QSI_S_ZN_emkP0oSe9Qrn7kF","https://znemkp0ose9qrn7kf-elastic.siteintercept.qualtrics.com/WRSiteInterceptEngine/?Q_ZID=ZN_emkP0oSe9Qrn7kF")).start()}catch(i){}})();
    </script><div id="ZN_emkP0oSe9Qrn7kF"><!--DO NOT REMOVE-CONTENTS PLACED HERE--></div>
    <!--END WEBSITE FEEDBACK SNIPPET-->

    <div id="elastic-nav" style="display:none;"></div>
    <script src="https://www.elastic.co/elastic-nav.js"></script>

    <!-- Subnav -->
    <div>
      <div>
        <div class="tertiary-nav d-none d-md-block">
          <div class="container">
            <div class="p-t-b-15 d-flex justify-content-between nav-container">
              <div class="breadcrum-wrapper"><span><a href="/guide/" style="font-size: 14px; font-weight: 600; color: #000;">Docs</a></span></div>
            </div>
          </div>
        </div>
      </div>
    </div>

    <div class="main-container">
      <section id="content">
        <div class="content-wrapper">

          <section id="guide" lang="en">
            <div class="container">
              <div class="row">
                <div class="col-xs-12 col-sm-8 col-md-8 guide-section">
                  <!-- start body -->
                  <div class="page_header">
<strong>IMPORTANT</strong>: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
<a href="../current/index.html">current release documentation</a>.
</div>
<div id="content">
<div class="breadcrumbs">
<span class="breadcrumb-link"><a href="index.html">Elasticsearch Guide [7.7]</a></span>
»
<span class="breadcrumb-link"><a href="xpack-alerting.html">Alerting on cluster and index events</a></span>
»
<span class="breadcrumb-link"><a href="actions.html">Actions</a></span>
»
<span class="breadcrumb-node">Jira action</span>
</div>
<div class="navheader">
<span class="prev">
<a href="actions-pagerduty.html">« PagerDuty action</a>
</span>
<span class="next">
<a href="transform.html">Payload transforms »</a>
</span>
</div>
<div class="section xpack">
<div class="titlepage"><div><div>
<h2 class="title">
<a id="actions-jira"></a>Jira action<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/watcher/actions/jira.asciidoc">edit</a><a class="xpack_tag" href="/subscriptions"></a>
</h2>
</div></div></div>
<p>Use the <code class="literal">jira</code> action to create issues in  <a href="https://www.atlassian.com/software/jira" class="ulink" target="_top">Atlassian’s Jira Software</a>.
To create issues you need to <a class="xref" href="actions-jira.html#configuring-jira" title="Configuring Jira accounts">configure at least one Jira account</a> in <code class="literal">elasticsearch.yml</code>.</p>
<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="configuring-jira-actions"></a>Configuring Jira actions<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/watcher/actions/jira.asciidoc">edit</a>
</h3>
</div></div></div>
<p>You configure Jira actions in the <code class="literal">actions</code> array. Action-specific attributes
are specified using the <code class="literal">jira</code> keyword.</p>
<p>The following snippet shows a simple jira action definition:</p>
<div class="pre_wrapper lang-js">
<pre class="programlisting prettyprint lang-js">"actions" : {
  "create-jira-issue" : {
    "transform" : { ... },
    "throttle_period" : "5m",
    "jira" : {
      "account" : "integration-account", <a id="CO531-1"></a><i class="conum" data-value="1"></i>
      "fields" : {
          "project" : {
            "key": "PROJ" <a id="CO531-2"></a><i class="conum" data-value="2"></i>
          },
          "issuetype" : {
            "name": "Bug" <a id="CO531-3"></a><i class="conum" data-value="3"></i>
          },
          "summary" : "Encountered {{ctx.payload.hits.total.value}} errors in the last 5 minutes", <a id="CO531-4"></a><i class="conum" data-value="4"></i>
          "description" : "Encountered {{ctx.payload.hits.total.value}} errors in the last 5 minutes (facepalm)", <a id="CO531-5"></a><i class="conum" data-value="5"></i>
          "labels" : ["auto"], <a id="CO531-6"></a><i class="conum" data-value="6"></i>
          "priority" : {
            "name" : "High" <a id="CO531-7"></a><i class="conum" data-value="7"></i>
          }
      }
    }
  }
}</pre>
</div>
<div class="calloutlist">
<table border="0" summary="Callout list">
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO531-1"><i class="conum" data-value="1"></i></a></p>
</td>
<td align="left" valign="top">
<p>The name of a Jira account configured in <code class="literal">elasticsearch.yml</code>.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO531-2"><i class="conum" data-value="2"></i></a></p>
</td>
<td align="left" valign="top">
<p>The key of the Jira project in which the issue will be created.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO531-3"><i class="conum" data-value="3"></i></a></p>
</td>
<td align="left" valign="top">
<p>The name of the issue type.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO531-4"><i class="conum" data-value="4"></i></a></p>
</td>
<td align="left" valign="top">
<p>The summary of the Jira issue.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO531-5"><i class="conum" data-value="5"></i></a></p>
</td>
<td align="left" valign="top">
<p>The description of the Jira issue.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO531-6"><i class="conum" data-value="6"></i></a></p>
</td>
<td align="left" valign="top">
<p>The labels to apply to the Jira issue.</p>
</td>
</tr>
<tr>
<td align="left" valign="top" width="5%">
<p><a href="#CO531-7"><i class="conum" data-value="7"></i></a></p>
</td>
<td align="left" valign="top">
<p>The priority of the Jira issue.</p>
</td>
</tr>
</table>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="jira-action-attributes"></a>Jira action attributes<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/watcher/actions/jira.asciidoc">edit</a>
</h3>
</div></div></div>
<p>Depending of how Jira projects are configured, the issues can have many different fields and values. Therefore
the <code class="literal">jira</code> action can accept any type of sub fields within its <code class="literal">issue</code> field. These fields will be directly used
when calling Jira’s <a href="https://docs.atlassian.com/jira/REST/cloud/#api/2/issue-createIssue" class="ulink" target="_top">Create Issue API</a>, allowing
 any type of custom fields to be used.</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>The <code class="literal">project.key</code> (or <code class="literal">project.id</code>), the <code class="literal">issuetype.name</code> (or <code class="literal">issuetype.id</code>) and <code class="literal">issue.summary</code> are
always required to create an issue in Jira.</p>
</div>
</div>
<div class="informaltable">
<table border="1" cellpadding="4px">
<colgroup>
<col class="col_1">
<col class="col_2">
<col class="col_3">
</colgroup>
<thead>
<tr>
<th align="left" valign="top">Name</th>
<th align="center" valign="top">Required</th>
<th align="left" valign="top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p><code class="literal">account</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>The Jira account to use to send the message.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">proxy.host</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>The proxy host to use (only in combination with <code class="literal">proxy.port</code>)</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">proxy.port</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>The proxy port to use (only in combination with <code class="literal">proxy.host</code>)</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.project.key</code></p></td>
<td align="center" valign="top"><p>yes</p></td>
<td align="left" valign="top"><p>The key of the Jira project in which the issue will be created.
                                       It can be replaced by <code class="literal">issue.project.id</code> if the identifier of the
                                       project is known.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.issuetype.name</code></p></td>
<td align="center" valign="top"><p>yes</p></td>
<td align="left" valign="top"><p>A name that identifies the type of the issue. Jira provides default
                                       issue types like <code class="literal">Bug</code>, <code class="literal">Task</code>, <code class="literal">Story</code>, <code class="literal">New Feature</code> etc. It can
                                       be replaced by <code class="literal">issue.issuetype.id</code> if the identifier of the type
                                       is known.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.summary</code></p></td>
<td align="center" valign="top"><p>yes</p></td>
<td align="left" valign="top"><p>The summary (or title) of the issue.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.description</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>The description of the issue.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.labels</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>The labels to apply to the Jira issue.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.priority.name</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>The priority of the Jira issue. Jira provides default <code class="literal">High</code>,
                                       <code class="literal">Medium</code> and <code class="literal">Low</code> priority levels.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.assignee.name</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>Name of the user to assign the issue to.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.reporter.name</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>Name of the user identified as the reporter of the issue.
                                      Defaults to the user account.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.environment</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>Name of the environment related to the issue.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p><code class="literal">fields.customfield_XXX</code></p></td>
<td align="center" valign="top"><p>no</p></td>
<td align="left" valign="top"><p>Custom field XXX of the issue (ex: "customfield_10000": "09/Jun/81")</p></td>
</tr>
</tbody>
</table>
</div>
</div>

<div class="section">
<div class="titlepage"><div><div>
<h3 class="title">
<a id="configuring-jira"></a>Configuring Jira accounts<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/watcher/actions/jira.asciidoc">edit</a>
</h3>
</div></div></div>
<p>You configure the accounts Watcher can use to communicate with Jira in the
<code class="literal">xpack.notification.jira</code> namespace in <code class="literal">elasticsearch.yml</code>.</p>
<p>Watcher supports Basic Authentication for Jira Software. To configure a
Jira account you need to specify (see <a href="/guide/en/elasticsearch/reference/7.7/secure-settings.html" class="ulink" target="_top">secure settings</a>):</p>
<div class="pre_wrapper lang-yaml">
<pre class="programlisting prettyprint lang-yaml">bin/elasticsearch-keystore add xpack.notification.jira.account.monitoring.secure_url
bin/elasticsearch-keystore add xpack.notification.jira.account.monitoring.secure_user
bin/elasticsearch-keystore add xpack.notification.jira.account.monitoring.secure_password</pre>
</div>
<div class="warning admon">
<div class="icon"></div>
<div class="admon_content">
<p>Storing sensitive data (<code class="literal">url</code>, <code class="literal">user</code> and <code class="literal">password</code>) in the configuration file or the cluster settings is insecure and has been deprecated. Please use Elasticsearch’s secure <a href="/guide/en/elasticsearch/reference/7.7/secure-settings.html" class="ulink" target="_top">keystore</a> method instead.</p>
</div>
</div>
<p>To avoid credentials that transit in clear text over the network, Watcher will
reject <code class="literal">url</code> settings like <code class="literal">http://internal-jira.elastic.co</code> that are based on
plain text HTTP protocol. This default behavior can be disabled with the explicit
 <code class="literal">allow_http</code> setting:</p>
<div class="note admon">
<div class="icon"></div>
<div class="admon_content">
<p>The <code class="literal">url</code> field can also contain a path, that is used to create an issue. By
default this is <code class="literal">/rest/api/2/issue</code>. If you set this as well, make sure that this
path is the full path to the endpoint to create an issue.</p>
</div>
</div>
<div class="pre_wrapper lang-yaml">
<pre class="programlisting prettyprint lang-yaml">xpack.notification.jira:
  account:
    monitoring:
      allow_http: true</pre>
</div>
<div class="warning admon">
<div class="icon"></div>
<div class="admon_content">
<p>It is strongly advised to use Basic Authentication with secured HTTPS
 protocol only.</p>
</div>
</div>
<p>You can also specify defaults for the
<a class="xref" href="notification-settings.html#jira-account-attributes">Jira issues</a>:</p>
<div class="pre_wrapper lang-yaml">
<pre class="programlisting prettyprint lang-yaml">xpack.notification.jira:
  account:
    monitoring:
      issue_defaults:
        project:
          key: proj
        issuetype:
          name: Bug
        summary: "X-Pack Issue"
        labels: ["auto"]</pre>
</div>
<p>If you configure multiple Jira accounts, you either need to configure a default
account or specify which account the notification should be sent with in the
<a class="xref" href="actions-jira.html" title="Jira action"><code class="literal">jira</code></a> action.</p>
<div class="pre_wrapper lang-yaml">
<pre class="programlisting prettyprint lang-yaml">xpack.notification.jira:
  default_account: team1
  account:
    team1:
      ...
    team2:
      ...</pre>
</div>
<h3>
<a id="actions-ssl-openjdk"></a>Using SSL/TLS with OpenJDK<a class="edit_me edit_me_private" rel="nofollow" title="Editing on GitHub is available to Elastic" href="https://github.com/elastic/elasticsearch/edit/7.7/x-pack/docs/en/watcher/actions.asciidoc">edit</a>
</h3>
<p>As each distributor is free to choose how to package OpenJDK, it may happen,
that even despite the exact same version, an OpenJDK distribution contains
different parts under different Linux distributions.</p>
<p>This can lead to issues with any action or input that uses TLS, like the <code class="literal">jira</code>,
<code class="literal">pagerduty</code>, <code class="literal">slack</code>, or <code class="literal">webhook</code> one, because of missing CA certs.
If you encounter TLS errors, when writing watches that connect to TLS endpoints,
you should try to upgrade to the latest available OpenJDK distribution for your
platform and if that does not help, try to upgrade to Oracle JDK.</p>
</div>

</div>
<div class="navfooter">
<span class="prev">
<a href="actions-pagerduty.html">« PagerDuty action</a>
</span>
<span class="next">
<a href="transform.html">Payload transforms »</a>
</span>
</div>
</div>

                  <!-- end body -->
                </div>
                <div class="col-xs-12 col-sm-4 col-md-4" id="right_col">
                  <div id="rtpcontainer" style="display: block;">
                    <div class="mktg-promo">
                      <h3>Most Popular</h3>
                      <ul class="icons">
                        <li class="icon-elasticsearch-white"><a href="https://www.elastic.co/webinars/getting-started-elasticsearch?baymax=default&amp;elektra=docs&amp;storm=top-video">Get Started with Elasticsearch: Video</a></li>
                        <li class="icon-kibana-white"><a href="https://www.elastic.co/webinars/getting-started-kibana?baymax=default&amp;elektra=docs&amp;storm=top-video">Intro to Kibana: Video</a></li>
                        <li class="icon-logstash-white"><a href="https://www.elastic.co/webinars/introduction-elk-stack?baymax=default&amp;elektra=docs&amp;storm=top-video">ELK for Logs &amp; Metrics: Video</a></li>
                      </ul>
                    </div>
                  </div>
                </div>
              </div>
            </div>
          </section>

        </div>


<div id="elastic-footer"></div>
<script src="https://www.elastic.co/elastic-footer.js"></script>
<!-- Footer Section end-->

      </section>
    </div>

<script src="/guide/static/jquery.js"></script>
<script type="text/javascript" src="/guide/static/docs.js"></script>
<script type="text/javascript">
  window.initial_state = {}</script>
  </body>
</html>
